home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / bbs_util / mscan200.zip / MAILSCAN.DOC < prev    next >
Text File  |  1991-07-27  |  16KB  |  380 lines
  1.  
  2.  
  3.         MAILSCAN: v1.01                                   by Stephen de Plater
  4.         27 July, 1991                                 GT Network Address 302/1
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                        MAILSCAN
  13.                                  by Stephen de Plater
  14.                                GT Network Address: 302/1
  15.                                  Voice: +61 2 976-2801
  16.                                  Data: +61 2 977-2013
  17.  
  18.  
  19.  
  20.         ======================================================================
  21.         0.                           REVISION LIST
  22.         ======================================================================
  23.  
  24.         VERSION:  Release Date:       Comments:
  25.         -------   ------------        --------------------------------------
  26.         1.00      April 23, 1991      First Release.
  27.  
  28.         1.01      July 27, 1991       Minor  change  to  accomodate   the  new
  29.                                       GTMDIR format (groups).
  30.  
  31.                                       DOCUMENTATION CHANGE: Note the new VOICE
  32.                                       number here at Kangaroo Korner.  The BBS
  33.                                       number remains unchanged.
  34.  
  35.  
  36.         ======================================================================
  37.         1.                             COPYRIGHT
  38.         ======================================================================
  39.  
  40.         MAILSCAN is not placed in the Public Domain. The copyright is retained
  41.         and the software is provided on licence:
  42.  
  43.         You are free to  use and make  as many copies of  this program as  you
  44.         wish.  You may also give it away to  any nodelisted GT Sysop who wants
  45.         it, provided:
  46.  
  47.                   1.   No fee is charged.
  48.                   2.   This archive is distributed intact.
  49.                   3.   You  register  the package  with an  OZNET registration
  50.                        centre.
  51.  
  52.  
  53.  
  54.  
  55.                                      >> page 1 <<
  56.  
  57.         MAILSCAN: v1.01                                   by Stephen de Plater
  58.         27 July, 1991                                 GT Network Address 302/1
  59.  
  60.  
  61.  
  62.         Beta  code should  be treated  exactly as  full releases  are treated.
  63.         That is,  beta code may  also be distributed  to any nodelisted  Sysop
  64.         without restriction.   You should be aware  of course, that  beta code
  65.         may not be as refined  as the full release versions would be, and what
  66.         you see there may change when the beta tag is removed.
  67.  
  68.  
  69.         ======================================================================
  70.                                      REGISTRATION
  71.         ======================================================================
  72.  
  73.         A  new  registration  scheme  now   applies  to  all  OZNET  software.
  74.         Regardless  of any  previous registration,  this program  now requires
  75.         individual installation for each BBS using it.
  76.  
  77.         There  is  still NO  fee  involved  at all.  DO  NOT  send any  money!
  78.         Registration  simply  involves  obtaining from  me  a  CRC code  which
  79.         matches  your  BBS  name.    You  may do  this  at  any  of  the OZNET
  80.         registration centres:
  81.  
  82.                   Kangaroo Korner          302/001   Stephen de Plater
  83.                   The Black Hole           302/003   Ken Thompson
  84.                   Control Systems          071/001   Ed Cavender
  85.                   Gidget's Domain          081/005   Jack Hazel
  86.                   Fuzzy Logic              050/018   Phill Piddell
  87.                   Geno's Place             044/003   Gene Newcomb
  88.                   InfoStation              032/001   Perry Alexander
  89.  
  90.         If you are in  the nodelist then you will  be able to register  direct
  91.         online at  any of those  centres or via  mail in  the correct form  to
  92.         OZRobot at any of  those centres.  See  the included OZRobot  document
  93.         for details.   If you are not  in the net you  will need to apply  via
  94.         private netmail or  message to Sysop at any of  the centres.  Whatever
  95.         way you  do it you will need to supply  the full (case sensitive) name
  96.         to which you want the program registered.
  97.  
  98.         You will also  need to obtain the OZINSTAL program  which performs the
  99.         actual installation.  OZINSTAL  is not included in this archive.   You
  100.         should look for OZINST11.ZIP.
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.                                      >> page 2 <<
  110.  
  111.         MAILSCAN: v1.01                                   by Stephen de Plater
  112.         27 July, 1991                                 GT Network Address 302/1
  113.  
  114.  
  115.  
  116.         ======================================================================
  117.         3.                              PURPOSE
  118.         ======================================================================
  119.  
  120.                          (Or what does this thing do anyway?)
  121.  
  122.         MAILSCAN is  a  logon door  program  for GT  Power  BBS Systems.    It
  123.         contains  the mailscan code from  GREETING, for those  wishing to have
  124.         the mail scan feature but not running GREETING itself.  Users are told
  125.         of exactly what mail is  waiting for them.   The mail area number  and
  126.         description  are shown, and for each message the message number, date,
  127.         sender, and  topic are  listed.  A  star "*" is  used to  flag private
  128.         mail.
  129.  
  130.  
  131.         ======================================================================
  132.         4.                               USAGE
  133.         ======================================================================
  134.  
  135.         To use MAILSCAN install it as a logon door (GTLOGON.BAT) like this:
  136.  
  137.              @echo off 
  138.              gtdrwy 
  139.              doorway [various params]mailscan [various params]
  140.  
  141.         It is not necessary to place a PAUSE at the end, the program will wait
  142.         and the user to press any key to continue.
  143.  
  144.         The parameters are optional and function as follows:
  145.  
  146.          1.  /M   Force monochrome.
  147.  
  148.          2.  /G   An alternate GTPATH.  I can't see where  this would be used,
  149.                   but the code was around and it only took a couple of lines.
  150.  
  151.          3.  /J   Force  joins users to areas which they have not accessed but
  152.                   have mail waiting for.
  153.  
  154.                   Default: OFF.
  155.  
  156.          4.  /N   The access level at or below which the program runs.  If you
  157.                   don't want to run a mailscan  at all for users at say, level
  158.                   '9' or above, then you  could use /NA.  Of course  you could
  159.                   do the same thing by running chkacc in  your batch file, but
  160.                   this makes that simpler.
  161.  
  162.  
  163.                                      >> page 3 <<
  164.  
  165.         MAILSCAN: v1.01                                   by Stephen de Plater
  166.         27 July, 1991                                 GT Network Address 302/1
  167.  
  168.  
  169.  
  170.                   Default: /N0
  171.  
  172.          5.  /S   The  access level at or  above which a  partial scan occurs.
  173.                   The /Wstring parameter MUST be  specified for this to  work.
  174.                   If say, /SG was specified then all  users at or above access
  175.                   level  'G' would get a partial scan.  The /Wstring parameter
  176.                   controls what "partial" means. See below.
  177.  
  178.                   Default: /Sz
  179.  
  180.          6.  /C   The call number for the  day at which a user (regardless  of
  181.                   the access level specified  in /S above) is given  a partial
  182.                   scan.  If this is say, /C2 then all users on their second or
  183.                   later call in one day would be given a partial scan.  Again,
  184.                   see the  /Wstring parameter below for  what "partial" means.
  185.                   Also  again, the  /Wstring parameter  MUST be  specified for
  186.                   this to work.
  187.  
  188.                   Default: /C32767
  189.  
  190.                   NOTE: the relation  between the  /S and /C  parameters is  a
  191.                   logical OR.  That is, /SG /C2 would mean that a partial scan
  192.                   would  be performed when either the user was at access level
  193.                   'G' or higher, OR  was calling for at least  the second time
  194.                   in one day.
  195.  
  196.          7.  /W   If  a partial  scan  is a  possibility  then this  field  is
  197.                   essential.  If  the 'string'  (case  independent!)  is found
  198.                   anywhere on a line in the GTMDIR.BBS, then that message area
  199.                   will not be scanned in a partial scan.
  200.  
  201.         EXAMPLE:  At Kangaroo Korner  the only  mail areas which  are set  for
  202.                   "public messages only" are the echo areas.   They all have a
  203.                   "^"  symbol in the GTMDIR.BBS (to make them public only) and
  204.                   they are the only ones which do have that here.  Therefore I
  205.                   can use that  single character as the string to scan for. Of
  206.                   course, if you always  use the word "echo" in  your echomail
  207.                   descriptions then you could just as easily check for that.
  208.  
  209.                   Here, I turn  the scan on for everyone (so I leave the /N at
  210.                   the default  of /N0), I give partial scans to those at level
  211.                   'G' or above, (using  /SG) and anyone who is on their second
  212.                   or later call for the day is also given a partial scan (with
  213.                   a /C2).   I  scan  for the  'string' "^"  to  catch all  the
  214.                   echomail areas (with /W^).
  215.  
  216.  
  217.                                      >> page 4 <<
  218.  
  219.         MAILSCAN: v1.01                                   by Stephen de Plater
  220.         27 July, 1991                                 GT Network Address 302/1
  221.  
  222.  
  223.  
  224.         NOTES:    With a full  scan a lot of  lines can be generated.   With a
  225.                   fast modem they can be gone quickly off the screen.   If the
  226.                   user has  the NONSTOP  flag set  OFF (so  that  GT asks  for
  227.                   "More?"  at the end  of each  screenful, then  MAILSCAN will
  228.                   also pause.   The size of the  screen will be determined  by
  229.                   what the user told GT  it was when he joined as a  new user.
  230.                   If  that field of his  USER.CTL is blank  (for those joining
  231.                   before  GT16),  then MAILSCAN  will  assume a  length  of 24
  232.                   lines.
  233.  
  234.         TIMING:   MAILSCAN is the thing which  is REALLY going to show up  the
  235.                   differences  in people's hardware!  I know of one alpha test
  236.                   site which was experiencing a scan lasting about three and a
  237.                   half  minutes  with  125  mail  areas  being  scanned.   The
  238.                   hardware was a  turbo XT with a 4:1 interleave  hard disk on
  239.                   an 8 bit controller.  Using a decent cache program will help
  240.                   --  probably halving the scan  times (in my  experience).  I
  241.                   use Hyperdisk and highly recommend it.
  242.  
  243.                   On  this  machine  (a 386/25  with  a  1  MB  cache,  a  1:1
  244.                   interleave disk with 25 msec access times, and an adaptec 16
  245.                   bit RLL controller) running under  DesqView with the BBS  in
  246.                   one partition and  4DOS in a  second partition, the  timings
  247.                   worked out as below for 107 message areas:
  248.  
  249.                        cache ON            cache OFF
  250.                        6.54 seconds        16.97 seconds
  251.  
  252.                   These  times are slightly better  than the same code running
  253.                   in  GREETING because  MAILSCAN being  a smaller  program has
  254.                   more  room left  for  a  bigger  buffer.    Under  the  same
  255.                   conditions GREETING returned times of:
  256.  
  257.                        cache ON            cache OFF
  258.                        8.40 seconds        18.40 seconds
  259.  
  260.                   The VERY best  scan times  I could get  were obtained  using
  261.                   MAILSCAN  program,  dropping  out   of  DesqView  to  single
  262.                   tasking, and expanding the  cache to 3 MBytes, for  the same
  263.                   107 mail areas, the scan took 1.74 seconds!
  264.  
  265.  
  266.         The  command line  options must  be separated  by white  space, (i.e.:
  267.         "/M/N0" is not valid, but "/M /N0" is). They may be in either upper or
  268.  
  269.  
  270.  
  271.                                      >> page 5 <<
  272.  
  273.         MAILSCAN: v1.01                                   by Stephen de Plater
  274.         27 July, 1991                                 GT Network Address 302/1
  275.  
  276.  
  277.  
  278.         lower  case, and  supplied in  any order.  Also, you  may use  the '-'
  279.         character as the command line parameter flag instead of '/'.
  280.  
  281.         (i.e.: "-M" is fine.)
  282.  
  283.  
  284.                                    ERRORLEVEL EXITS:
  285.  
  286.         MAILSCAN will exit with  one of the following errorlevels. In this way
  287.         your  batch  files can  check what  MAILSCAN  has discovered  and take
  288.         appropriate action. The errorlevels which may be set are:
  289.  
  290.                   0         Normal termination, no mail waiting.
  291.                   1 to 254  The number  of unread messages waiting.   If there
  292.                             are  more than  254 unread  messages, 254  will be
  293.                             returned.   (It also  means that  you have  a VERY
  294.                             popular user <GRIN>!)
  295.                   255       An  error has  occurred.   This will  generally be
  296.                             flagged by  a highlighted message asking  the user
  297.                             to  contact the Sysop.  The nature of the error is
  298.                             shown in the message.
  299.  
  300.  
  301.         ======================================================================
  302.         5.                              COLOURS
  303.         ======================================================================
  304.  
  305.         If  the user has  ansi graphics selected  (and if you  have not forced
  306.         monochrome mode with the /M command line parameter), MAILSCAN will run
  307.         in the colours of your  BBS.  If you  don't like the colours you  see,
  308.         don't blame me -- after all you chose them <grin>.
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.                                      >> page 6 <<
  326.  
  327.         MAILSCAN: v1.01                                   by Stephen de Plater
  328.         27 July, 1991                                 GT Network Address 302/1
  329.  
  330.  
  331.  
  332.         ======================================================================
  333.         6.                            DISCLAIMER
  334.         ======================================================================
  335.  
  336.         Q:         What kind of guarantee comes with this software?
  337.  
  338.         A:                    *** ABSOLUTELY NONE!!! ***
  339.  
  340.         If you break it you get to keep both halves!
  341.  
  342.         I take no responsibility  at all for what this software may  do on any
  343.         computer other than my own. If you use it you do so at your  own risk.
  344.         All that I am prepared to say about it is that it works fine here (and
  345.         I can see no good reason  why it should not also work fine  everywhere
  346.         else also -- but ....)
  347.  
  348.         By using this program you accept these conditions.
  349.  
  350.  
  351.         ======================================================================
  352.         7.                              ENJOY!
  353.         ======================================================================
  354.  
  355.         At least, I hope you do!
  356.         Stephen
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.                                      >> page 7 <<
  380.